﻿/**
 *       Project: ServerLib
 *     Copyright: Copyright (C) 2008, Rob Kennedy
 *   Create Date: 2008-07-14 10:16 PM
 * Modified Date: 2008-07-14 10:16 PM    RK  Added comments
 *      Comments: Ignore SA1633.
 *      
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace ServerLib.Network
{
    using System;

    /// --------------------------------------------------------------------
    /// Project	 : ServerLib
    /// Class	 : DataLineReceiveArgs
    /// Inherits : None.
    /// --------------------------------------------------------------------
    /// <summary>
    /// Argument class for the Enhanced socket data receive event
    /// </summary>
    /// <authorname>Rob Kennedy</authorname>
    /// <remarks></remarks>
    /// --------------------------------------------------------------------
    public class DataLineReceiveArgs : EventArgs
    {
        #region Private Properties

        /// <summary>Contains the data string received from the socket</summary>
        private string dataReceived;

        #endregion

        #region Public Properties

        /// <summary>Gets the data received from the socket</summary>
        public string DataReceived
        {
            get
            {
                return this.dataReceived;
            }
        }

        #endregion

        #region Public Constructors

        /// <summary>Constructs a data receive argument object</summary>
        public DataLineReceiveArgs() : this(string.Empty) 
        { 
        }

        /// <summary>
        /// Constructs a data receive argument object
        /// </summary>
        /// <param name="dataString">The data received from the socket</param>
        public DataLineReceiveArgs(string dataString)
        {
            this.dataReceived = dataString;
        }
        #endregion
    }
}
